home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / yamck100.arc / YAMCHEK.DOC < prev    next >
Text File  |  1988-05-18  |  12KB  |  306 lines
  1.         YAMCHEK.EXE                                    Release 1.10
  2.  
  3.  
  4.  
  5.                    Yamchek (Yet Another Mail CHEcK utility)
  6.  
  7.         usage: yamchek {-p#} {-t#} {-s} {-m <mail area list>}
  8.  
  9.                -p#     port number, where # is from 1 to 16.
  10.                        Example: -p2 for com port 2
  11.                        Default: com 1.
  12.  
  13.                -t#     maximum time in minutes allowed in Yamchek.
  14.                        Example: -t30 is for 30 minutes.
  15.                        Default: 15 minutes maximum.
  16.  
  17.                -s      turns  on snoop mode showing sysop what  caller
  18.                        sees on local screen.
  19.                        Example: -s
  20.                        Default: snoop mode off, screen blank.
  21.  
  22.                -m      followed by a list of areas to scan.
  23.                        Example: -m 1 2 3 restricts scans to mail areas
  24.                        1,   2,  and  3  as  defined  in   system1.bbs,
  25.                        system2.bbs,  and system3.bbs if  the  caller's
  26.                        priv level will allow it.
  27.                        Default:  scans  all mail areas  that  caller's
  28.                        priv level will allow.
  29.  
  30.                Note:   no space must appear between the switches  '-p'
  31.                        and  '-t' and the number, as in '-p2' for  port
  32.                        2.
  33.  
  34.         example:       ^OCyamchek -p2 -t20 -m 1 2 3 4 -s
  35.  
  36.                        sets  communications  on com2:, 20  minute  max
  37.                        time limit, restricts searches to mail areas 1,
  38.                        2,  3, and 4, and turns on snoop mode. This  is
  39.                        an Opus menu spawn (^OC).
  40.  
  41.         Yamchek  (Yet Another Mail Checker) is designed  for  external
  42.         operation from Opus style menus via the embedded ^OC  command.
  43.         Yamchek is complete unto itself, and requires no other support
  44.         files other than those provided for Opus use (but please check
  45.         "Requirements"  below). When Yamchek is called from  Opus,  it
  46.         first  reads in the file created by Opus called  LASTUSER.BBS,
  47.         which  Opus creates during the spawn. Within this file is  the
  48.         complete  user  structure  including name,  priv  level,  help
  49.         level,  etc.  Yamchek makes full use of  the  user  structure.
  50.         Yamchek  currently recognizes the structure supported by  Opus
  51.         1.03b  and  earlier  Opus systems. If  Yamchek  can  not  find
  52.         lastuser, it will exit.
  53.  
  54.         A  short greeting is displayed showing the program's name  and
  55.         version number, port calling in on, date last compiled, and my
  56.         copyright,  followed  by another line with the  caller's  full
  57.         name and the maximum time allowed in Yamchek. Then the  caller
  58.         is then asked if they want to scan for new mail. If the answer
  59.  
  60.  
  61.         YAMCHEK 1.10                                                 1
  62.         YAMCHEK.EXE                                    Release 1.10
  63.  
  64.  
  65.         is  'Y' or [Enter], then processing proceeds. If 'N',  Yamchek
  66.         exits back to Opus.
  67.  
  68.                                Caller's Options
  69.  
  70.         Once the caller is in Yamchek, they will be asked if they want
  71.         to  List their mail, Read their mail, or Cleanup  their  mail.
  72.         In all three cases each area being scanned is presented to the
  73.         caller  by area number, area tag, lowest message  and  highest
  74.         message.  The  caller is then asked if they want  to  continue
  75.         scanning  that area. If the caller is not interested  in  that
  76.         area, they MUST type 'N'o to skip that area. A 'Y' or  [Enter]
  77.         will continue processing in that area. Any new mail  addressed
  78.         to  that  caller and found in that area is  presented  to  the
  79.         caller.
  80.  
  81.         Selecting  List  mode presents the mail in a  simple  two-line
  82.         format  with no other intervention on the part of the  caller.
  83.         In  the case of List mode the two-line format gives  them  the
  84.         message number, date written, and who it is from on the  first
  85.         line. The second line shows the subject of the message.
  86.  
  87.         When  a  caller  selects  to Read  their  mail,  the  mail  is
  88.         presented  as if they were reading it in an Opus mail area.  A
  89.         full  header of information is presented followed by the  body
  90.         of  the message. As each message is read, it is always  marked
  91.         as having been received. This does not happen in list mode and
  92.         requires  that the caller go into Opus' mail section and  read
  93.         each message.
  94.  
  95.         The  most  complicated selection is  Cleanup.  Under  cleanup,
  96.         callers  see each new message listed in two-line  format,  but
  97.         they  are asked if they want to Mark the message  as  received
  98.         without reading it, Read it, or Skip it. If they elect to mark
  99.         the  message  Yamchek  does so and moves on to  the  next  new
  100.         message. If they elect to review the message by reading it, it
  101.         will still be marked as received. If they elect to skip it, it
  102.         stays in the message base as new mail.
  103.  
  104.         In both cases where the callers have to select an option, they
  105.         area  given  help in the form of '?=help'  that  explains  the
  106.         choices in a clear manner (I hope).
  107.  
  108.                            Command Line Parameters
  109.  
  110.         The four possible switches on the command line, '-p', '-t', '-
  111.         s',  and  '-m <area list>' are described at the start  of  the
  112.         document.  You should realise that if you do not restrict  the
  113.         areas  that can be scanned with the '-m' list then all  system
  114.         files  will  be checked, and all areas allowed by  a  caller's
  115.         priv  level  will  be scanned.  Setting  the  restriction  can
  116.         considerably  speed up the message scan. In Opus  systems  you
  117.         will  have to hardcode this in either the menu ^OC command  or
  118.         in  the Outside declairation within the Opus control file.
  119.  
  120.  
  121.  
  122.         YAMCHEK 1.10                                                 2
  123.         YAMCHEK.EXE                                    Release 1.10
  124.  
  125.  
  126.         In  addition  to  setting  snoop and  time  with  the  command
  127.         switches, Yamchek also allows local keyboard control of  these
  128.         parameters.  You  can  get a menu of  available  functions  by
  129.         typing  return at the local keyboard. You can turn snoop  mode
  130.         o'N' or 'O'ff, raise or lower the time limit, 'C'hat with  the
  131.         caller, or set up simultanious keyboards. You also have the ^X
  132.         option  to  kick  a caller out of Yamchek,  but  not  off  the
  133.         system.  You will need to type ^X again to kick a  caller  off
  134.         completely.  The reason for not allowing total  disconnect  on
  135.         Yamchek  is to avoid a reboot if automatic carrier  detect  is
  136.         enabled (watch dog).
  137.  
  138.                                  Requirements
  139.  
  140.         Yamchek  currently requires X00 v.08a or greater for  reliable
  141.         operation. Operation is not guaranteed for earlier releases or
  142.         for other FOSSIL drivers, especially Opus!Comm 5.2 or earlier.
  143.         USING OPUS!COMM IS A SURE WAY TO LOCK UP YOUR SYSTEM.
  144.  
  145.         Yamchek  has been written to work with Opus 1.03b.  It  should
  146.         work  with  earlier versions of Opus and with Fido  v11w,  but
  147.         there  are  no  guarantees. There is also  no  guarantee  that
  148.         Yamchek will work with Opus 1.10iii gamma.
  149.  
  150.         Yamchek requires MS-DOS 3.0 or greater and any MS-DOS  machine
  151.         that  can  support ANSI color sequences or can  run  a  screen
  152.         device driver equivalent to ANSI.SYS.
  153.  
  154.         Direct  comments or questions to William Beebe at  node  363/3
  155.         via matrix mail or in the Sysop 18 conference SYSOP18. You can
  156.         write me at 6125 Orange Cove Drive, Orlando FL, 32819.
  157.  
  158.         Copyright 1988 William H. Beebe IV.
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.         YAMCHEK 1.10                                                 3
  184.         YAMCHEK.EXE                                    Release 1.10
  185.  
  186.  
  187.                                Revision History
  188.  
  189.         0.0    Initial   release.   Tested  on   363/1.   Considerable
  190.         5/6    difficulty  making fossil interface work at first.  All
  191.                code ported from source developed on YABBS Shell.
  192.  
  193.         0.1    First  beta released to additional nodes,  specifically
  194.         5/8    my NC (poor guy) at 363/3 and Pat Keller at 363/15.
  195.  
  196.         0.3    This version fixed in a flaw in the mail scan  routine.
  197.         5/9    It  would not scan the very last message in  the  area.
  198.                Also  added  mail  area restriction  per  Pat  Keller's
  199.                suggestion  and the snoop switch for my own  and  Pat's
  200.                use.
  201.  
  202.         0.33   Finally  fixed  (I  hope) a problem  with  how  Yamchek
  203.         5/10   displays pages of a message in R)ead mode. It now works
  204.                so  that  the  ansi  sequences  for  positioning   each
  205.                successive page will only be sent to the caller if ANSI
  206.                and MORE and FORMFEED are all enabled. Disabling any of
  207.                this  forces the message to simply scroll up the  page.
  208.                In addition, the variable ln_cnt is now counted up, not
  209.                down, and is modified in the Yamlib routines rawdisplay
  210.                and  sendbyte. A test is made for '\n', and when  true,
  211.                the  line count is incremented. This results in a  much
  212.                cleaner  "More" prompt. Released to 363/3, 363/10,  and
  213.                363/15
  214.  
  215.         0.34   Cleaned  up the listing so that only the date is  shown
  216.         5/10   in  line mode, cleaned up the placement of  lines,  and
  217.                added  a simple "List" and "Read" tag when the mode  is
  218.                selected.
  219.  
  220.         0.35   Cleaned up a bug I missed in the switch parser. If  the
  221.         5/11   mail area list is the only switch on the command  line,
  222.                then  there was no way to determine when all the  parms
  223.                had  been  processed. The only test was  for  the  next
  224.                switch prefixed with a '-'. It will now work  correctly
  225.                with only '-m' on the command line and with any  number
  226.                of message areas.
  227.  
  228.         0.36   Worked  on  the  user  interface  again.  Changed   the
  229.         5/11   greating  to explicitly tell the caller they  have  'X'
  230.                minutes in Yamchek. Made Yamchek respond send a 'Y'  or
  231.                'N'  to  the caller on  the  check-your-mail  question.
  232.                Added help to the list-or-read question so that callers
  233.                (hopefully)  have a better idea what to do. Release  to
  234.                363/3, 363/10, and 363/15.
  235.  
  236.         0.40   Added  code  to  drop  DTR after  an  init  if  Yamchek
  237.         5/12   determines  it  is  in local keyboard  mode.  Added  an
  238.                additional  feature, the ability to mark a  message  as
  239.                received during a list of mail waiting. Increased  help
  240.                text as well.
  241.  
  242.  
  243.  
  244.         YAMCHEK 1.10                                                 4
  245.         YAMCHEK.EXE                                    Release 1.10
  246.  
  247.  
  248.         0.41   Maintainance  release. Cleaned up mis-spellings in  the
  249.         5/13   help  text  and cleaned up a programming  ommission  in
  250.                that the default in Cleanup was Skip, not Mark.
  251.  
  252.         0.50   Added question selection to ask caller if they want  to
  253.                scan a particular mail area. This should make  scanning
  254.                for  new  mail even faster, allowing  callers  to  skip
  255.                areas  in  the allowable list that do  not  pertain  to
  256.                them.
  257.  
  258.         1.00   Official release. Added an additional prompt at end  of
  259.         5/15   mail scan.
  260.  
  261.         1.10   Fixed  tick-timer  code  to work  with  X00  1.08a  and
  262.         5/18   beyond.
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.         YAMCHEK 1.10                                                 5
  306.